<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Class <i>OverlayCtrlInfo</i></h2>
<b>File: <a href="src-common-CommonMessages.msg.html">src/common/CommonMessages.msg</a></b><br/><p><a href="../doxy/classOverlayCtrlInfo.html" target="mainframe"><b>C++ definition</b></a></p>

<p>Control info for internal handling BaseOverlaMessages.</p>
<p><b>Author:</b> Bernhard Heep</p>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram.
Click <a href="full-msg-usage-diagram.html">here</a> to see the full picture.</p>
<img src="OverlayCtrlInfo-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="OverlayCtrlInfo.html" title="Class OverlayCtrlInfo" alt="" coords="5,6,115,34">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram.
Click <a href="full-msg-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="OverlayCtrlInfo-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="OverlayCtrlInfo.html" title="Class OverlayCtrlInfo" alt="" coords="5,6,115,34">
</map>
<h3 class="subtitle">Fields:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
   </tr>
<tr class="local">
   <td width="150">srcNode</td>
   <td width="100">
      <i>
NodeHandle</i>
   </td>
   <td>
<p>the message's source node IP/port/nodeID</p>
</td>
</tr>
<tr class="local">
   <td width="150">hopCount</td>
   <td width="100">
      <i>
int</i>
   </td>
   <td>
<p>hop count</p>
</td>
</tr>
<tr class="local">
   <td width="150">srcComp</td>
   <td width="100">
      <i>
int</i>
   </td>
   <td>
<p>source component</p>
</td>
</tr>
<tr class="local">
   <td width="150">destComp</td>
   <td width="100">
      <i>
int</i>
   </td>
   <td>
<p>destination component</p>
</td>
</tr>
<tr class="local">
   <td width="150">visitedHops</td>
   <td width="100">
      <i>
TransportAddress[]</i>
   </td>
   <td>
<p>hops on route</p>
</td>
</tr>
<tr class="local">
   <td width="150">lastHop</td>
   <td width="100">
      <i>
TransportAddress</i>
   </td>
   <td>
<p>last hop node</p>
</td>
</tr>
<tr class="local">
   <td width="150">srcRoute</td>
   <td width="100">
      <i>
NodeHandle</i>
   </td>
   <td>
<p>like srcNode, but contains the source route to the destination (if available)</p>
</td>
</tr>
<tr class="local">
   <td width="150">transportType</td>
   <td width="100">
      <i>
int</i>
   </td>
   <td>
<p>transport type of the received message</p>
</td>
</tr>
<tr class="local">
   <td width="150">routingType</td>
   <td width="100">
      <i>
int</i>
   </td>
   <td></td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #808080; font-style: italic; ">//
// Control info for internal handling BaseOverlaMessages.
//
// </span><span style="color: #000080; ">@author</span><span style="color: #808080; font-style: italic; "> Bernhard Heep
//
</span><span style="color: #800000; font-weight: bold; ">class</span><span style="color: #000000; "> </span><span style="color: #000000; ">OverlayCtrlInfo</span><span style="color: #000000; ">
{
    </span><span style="color: #000000; ">TransportAddress</span><span style="color: #000000; "> </span><span style="color: #000000; ">lastHop</span><span style="color: #000000; ">;    </span><span style="color: #808080; font-style: italic; ">// last hop node
</span><span style="color: #000000; ">    </span><span style="color: #000000; ">NodeHandle</span><span style="color: #000000; "> </span><span style="color: #000000; ">srcNode</span><span style="color: #000000; ">;          </span><span style="color: #808080; font-style: italic; ">// the message's source node IP/port/nodeID
</span><span style="color: #000000; ">    </span><span style="color: #000000; ">NodeHandle</span><span style="color: #000000; "> </span><span style="color: #000000; ">srcRoute</span><span style="color: #000000; ">;         </span><span style="color: #808080; font-style: italic; ">// like srcNode, but contains the source route to the destination (if available) 
</span><span style="color: #000000; ">    </span><span style="color: #000080; font-weight: bold; ">int</span><span style="color: #000000; "> </span><span style="color: #000000; ">hopCount</span><span style="color: #000000; "> = </span><span style="color: #008000; ">0</span><span style="color: #000000; ">;            </span><span style="color: #808080; font-style: italic; ">// hop count
</span><span style="color: #000000; ">    </span><span style="color: #000000; ">TransportAddress</span><span style="color: #000000; "> </span><span style="color: #000000; ">visitedHops</span><span style="color: #000000; ">[];     </span><span style="color: #808080; font-style: italic; ">// hops on route
</span><span style="color: #000000; ">    </span><span style="color: #000080; font-weight: bold; ">int</span><span style="color: #000000; "> </span><span style="color: #000000; ">srcComp</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@enum</span><span style="color: #000000; ">(</span><span style="color: #000000; ">CompType</span><span style="color: #000000; ">);  </span><span style="color: #808080; font-style: italic; ">// source component
</span><span style="color: #000000; ">    </span><span style="color: #000080; font-weight: bold; ">int</span><span style="color: #000000; "> </span><span style="color: #000000; ">destComp</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@enum</span><span style="color: #000000; ">(</span><span style="color: #000000; ">CompType</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// destination component
</span><span style="color: #000000; ">    </span><span style="color: #000080; font-weight: bold; ">int</span><span style="color: #000000; "> </span><span style="color: #000000; ">transportType</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@enum</span><span style="color: #000000; ">(</span><span style="color: #000000; ">TransportType</span><span style="color: #000000; ">) = </span><span style="color: #000000; ">INVALID_TRANSPORT</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// transport type of the received message
</span><span style="color: #000000; ">    </span><span style="color: #000080; font-weight: bold; ">int</span><span style="color: #000000; "> </span><span style="color: #000000; ">routingType</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@enum</span><span style="color: #000000; ">(</span><span style="color: #000000; ">RoutingType</span><span style="color: #000000; ">);
}

</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
